Create person

POST /api/v1/Person/create

Description

This endpoint is used to create a new person.

Tags:
Person

URL:
/api/v{version}/Person/create

ApiKey:
No API key required

Content-Type:
application/json

Request Body:

jsonCopy code{
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "DateOfBirth": "string",
  "Gender": "string",
  "Address": "string",
  "PhoneNumber": "string",
  "EmailAddress": "string"
}

Query Parameters:
None

Response:
Success, returns the ID of the newly created person.

Error Codes:
None

Example:

bashCopy codePOST /api/v1/Person/create
Content-Type: application/json
Accept-Language: en
{
  "FirstName": "John",
  "MiddleName": "",
  "LastName": "Doe",
  "DateOfBirth": "1980-01-01",
  "Gender": "Male",
  "Address": "123 Main St, Anytown, USA",
  "PhoneNumber": "123-456-7890",
  "EmailAddress": "john.doe@example.com"
}

/api/v1/Person/create

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "userId": `<uuid>`,
  "tenantId": `<uuid>`,
  "firstname": `<string>`,
  "middlename": `<string>`,
  "lastname": `<string>`,
  "identificationNumber": `<string>`,
  "phoneNumber": `<string>`,
  "phoneCode": `<string>`,
  "dateofBirth": `<dateTime>`,
  "gender": 1,
  "country": `<string>`,
  "email": `<string>`,
  "address": {
    "addressLine1": `<string>`,
    "addressLine2": `<string>`,
    "state": `<string>`,
    "city": `<string>`,
    "zipCode": `<string>`
  },
  "createdByAgent": `<boolean>`,
  "agentId": `<string>`,
  "kycRequired": `<boolean>`,
  "personDetails": {
    "emailAddress": `<string>`,
    "maritalStatus": `<string>`,
    "placeofBirth": `<string>`,
    "nationality": `<string>`,
    "lga": `<string>`,
    "state": `<string>`,
    "country": `<string>`,
    "address": `<string>`,
    "shopName": `<string>`,
    "bankName": `<string>`,
    "bankAccountNumber": `<string>`,
    "bankAccountName": `<string>`,
    "idType": `<string>`,
    "idNumber": `<string>`,
    "staffInfo": `<string>`,
    "dateFormat": `<string>`,
    "locale": `<string>`
  }
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": "<string>"
}